Skip to content

Conversation

@i-am-tom
Copy link
Contributor

A blog post for the CLI environment variable changes.

@claude
Copy link
Contributor

claude bot commented Nov 18, 2025

Documentation Review

I've reviewed this blog post for PR #16595. Here are my findings:

Critical Issues

1. Missing frontmatter (line 1)
The blog post is missing required frontmatter fields. According to BLOGGING.md, blog posts must include:

  • date field
  • meta_image field
  • authors field
  • tags field

The file should start with proper frontmatter like:

---
title: "Controlling the CLI Through Environment Variables"
date: 2025-01-XX
meta_image: meta.png
authors:
    - i-am-tom
tags:
    - features
---

2. Missing trailing newline
The file must end with a newline character after the last line of content.

3. Incorrect heading level (line 2)
The H1 heading should only be specified in the frontmatter title field, not in the Markdown content. Remove the # Controlling the CLI through environment variables heading from line 2, as Hugo will render the title from frontmatter.

4. Title case issue (line 2)
The title uses "environment variables" but should be "Environment Variables" following Title Case convention for H1 headings per STYLE-GUIDE.md.

Style Issues

5. Sentence case for H2 headings (lines 6, 17, 26, 44)
H2 headings should use sentence case, not title case. Update:

  • Line 6: "The problem" ✓ (already correct)
  • Line 17: "The environment variable interface" ✓ (already correct)
  • Line 26: "Configuring project defaults" ✓ (already correct)
  • Line 44: "Wrapping up" ✓ (already correct)

Actually, all H2 headings are already correct - nice work!

6. Missing <!--more--> break
According to BLOGGING.md checklist, blog posts should include a <!--more--> break after the first paragraph to control what appears on the blog home page. Consider adding this after line 4 (after the introduction).

7. Link text clarity (line 10)
The link text "policy pack" is good, but consider if readers will understand the context. Current usage seems acceptable.

8. Code fence language (line 30)
The code fence uses shell but STYLE-GUIDE.md recommends using bash or sh for shell commands. Change line 30 from:

```bash

Content Suggestions

9. Code example completeness
The direnv example is good and realistic. The environment variable examples are clear and follow best practices.

10. Links verification
All internal and external links appear to be valid:

  • Policy pack link: ✓
  • --run-program blog link: ✓
  • direnv link: ✓
  • GitHub, X, Slack links: ✓

Positive Notes

  • Clear, engaging writing style appropriate for a blog post
  • Good use of concrete examples
  • Logical structure with problem → solution → application flow
  • Examples show realistic use cases
  • Links are descriptive and well-placed
  • American English spelling is correct throughout

Summary

This is a well-written blog post with clear technical content. The main issue is the missing frontmatter, which is required for Hugo to process the blog post correctly. Once the frontmatter is added and the minor formatting issues are addressed, this will be ready to publish.


Action Required: Please add the required frontmatter fields at the top of the file, remove the duplicate H1 heading, ensure the file ends with a newline, and consider adding a <!--more--> break.

If you'd like me to make these changes or need any clarification, mention @claude and I'll be happy to help!

@pulumi-bot
Copy link
Collaborator

@meagancojocar meagancojocar merged commit b04b3ab into master Nov 21, 2025
11 checks passed
@meagancojocar meagancojocar deleted the i-am-tom/env-vars branch November 21, 2025 15:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants